Skip to content

Conversation

@joshthoward
Copy link
Contributor

Summary

Consolidate information on WebSockets into best practices.

Screenshots (optional)

Documentation checklist

  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@github-actions github-actions bot added size/l product:durable-objects Durable Objects: https://developers.cloudflare.com/workers/learning/using-durable-objects/ product:workers Related to Workers product labels Nov 22, 2024
@github-actions
Copy link
Contributor

This PR changes current filenames or deletes current files. Make sure you have redirects set up to cover the following paths:

  • /durable-objects/api/websockets/
  • /durable-objects/reference/websockets/

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Nov 22, 2024

Deploying cloudflare-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 454a1ba
Status: ✅  Deploy successful!
Preview URL: https://cc6cad3a.cloudflare-docs-7ou.pages.dev
Branch Preview URL: https://joshthoward-do-websocket-ref.cloudflare-docs-7ou.pages.dev

View logs

@github-actions
Copy link
Contributor

github-actions bot commented Nov 22, 2024

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/durable-objects/best-practices/websockets/ https://joshthoward-do-websocket-ref.cloudflare-docs-7ou.pages.dev/durable-objects/best-practices/websockets/
https://developers.cloudflare.com/durable-objects/api/storage-api/ https://joshthoward-do-websocket-ref.cloudflare-docs-7ou.pages.dev/durable-objects/api/storage-api/
https://developers.cloudflare.com/durable-objects/api/websockets/ https://joshthoward-do-websocket-ref.cloudflare-docs-7ou.pages.dev/durable-objects/api/websockets/
https://developers.cloudflare.com/durable-objects/reference/websockets/ https://joshthoward-do-websocket-ref.cloudflare-docs-7ou.pages.dev/durable-objects/reference/websockets/
https://developers.cloudflare.com/durable-objects/api/state/ https://joshthoward-do-websocket-ref.cloudflare-docs-7ou.pages.dev/durable-objects/api/state/
https://developers.cloudflare.com/durable-objects/observability/graphql-analytics/ https://joshthoward-do-websocket-ref.cloudflare-docs-7ou.pages.dev/durable-objects/observability/graphql-analytics/
https://developers.cloudflare.com/durable-objects/examples/use-kv-from-durable-objects/ https://joshthoward-do-websocket-ref.cloudflare-docs-7ou.pages.dev/durable-objects/examples/use-kv-from-durable-objects/
https://developers.cloudflare.com/durable-objects/examples/websocket-hibernation-server/ https://joshthoward-do-websocket-ref.cloudflare-docs-7ou.pages.dev/durable-objects/examples/websocket-hibernation-server/
https://developers.cloudflare.com/durable-objects/examples/websocket-server/ https://joshthoward-do-websocket-ref.cloudflare-docs-7ou.pages.dev/durable-objects/examples/websocket-server/
https://developers.cloudflare.com/durable-objects/ https://joshthoward-do-websocket-ref.cloudflare-docs-7ou.pages.dev/durable-objects/
https://developers.cloudflare.com/durable-objects/platform/pricing/ https://joshthoward-do-websocket-ref.cloudflare-docs-7ou.pages.dev/durable-objects/platform/pricing/
https://developers.cloudflare.com/workers/examples/websockets/ https://joshthoward-do-websocket-ref.cloudflare-docs-7ou.pages.dev/workers/examples/websockets/
https://developers.cloudflare.com/workers/runtime-apis/rpc/lifecycle/ https://joshthoward-do-websocket-ref.cloudflare-docs-7ou.pages.dev/workers/runtime-apis/rpc/lifecycle/
https://developers.cloudflare.com/workers/runtime-apis/websockets/ https://joshthoward-do-websocket-ref.cloudflare-docs-7ou.pages.dev/workers/runtime-apis/websockets/

Copy link
Contributor

@Oxyjun Oxyjun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Leaving some suggestions to align with the style guide.

@Oxyjun
Copy link
Contributor

Oxyjun commented Nov 22, 2024

This PR deletes two WebSocket related files:

  • /durable-objects/api/websockets/
  • /durable-objects/reference/websockets/

Where do we want to redirect each of these paths?

We’ve only introduced one new file:

  • /durable-objects/best-practices/websockets/

@Oxyjun Oxyjun requested review from a team, KianNH, WalshyDev and pedrosousa as code owners November 22, 2024 15:19
@Oxyjun Oxyjun requested a review from aninibread as a code owner November 22, 2024 16:03
@joshthoward joshthoward merged commit 6cd02c7 into production Nov 22, 2024
12 checks passed
@joshthoward joshthoward deleted the joshthoward/do-websocket-refactor branch November 22, 2024 16:22
harshil1712 pushed a commit that referenced this pull request Dec 3, 2024
* Fix typo

* Update order and lint files

* Refactor Durable Objects WebSocket documentation

* Fixing bad Prettier automation in <code> blocks.

* Removing <br> and using MDX syntax.

* Update src/content/docs/durable-objects/api/alarms.mdx

Co-authored-by: Jun Lee <[email protected]>

* Apply suggestions from code review

Co-authored-by: Jun Lee <[email protected]>

* Fixing broken links to deleted chapters. Adding public redirect.

* Fixing broken links part 2

---------

Co-authored-by: Jun Lee <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:durable-objects Durable Objects: https://developers.cloudflare.com/workers/learning/using-durable-objects/ product:workers Related to Workers product size/l

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants